package org.jsola.hr.web;

import io.swagger.annotations.Api;
import io.swagger.annotations.ApiImplicitParam;
import io.swagger.annotations.ApiImplicitParams;
import io.swagger.annotations.ApiOperation;
import org.jsola.core.Page;
import org.jsola.core.Result;
import org.jsola.hr.dto.PolicyCourierAddDTO;
import org.jsola.hr.dto.PolicyCourierUpdateDTO;
import org.jsola.hr.query.PolicyCourierQuery;
import org.jsola.hr.vo.PolicyCourierListVO;
import org.jsola.hr.vo.PolicyCourierVO;

import java.util.List;

/**
 * 政策速递
 *
 * @author zhr
 */
@Api(tags = "hr-政策速递")
public interface IPolicyCourierControllerAPI {

    /**
     * 新增政策速递
     * @param policyCourierAddDTO 政策速递新增实体
     * @return 政策速递展示对象
     */
    @ApiOperation(value = "新增政策速递")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "policyCourierAddDTO", dataType = "PolicyCourierAddDTO", value = "新增政策速递", paramType = "body")
    })
    Result<PolicyCourierVO> save(PolicyCourierAddDTO policyCourierAddDTO);


    /**
     * 修改政策速递
     * @param policyCourierUpdateDTO 政策速递
     * @return 更新数量
     */
    @ApiOperation(value = "修改政策速递")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "policyCourierUpdateDTO", dataType = "PolicyCourierUpdateDTO", value = "修改政策速递", paramType = "body")
    })
    Result<Integer> update(PolicyCourierUpdateDTO policyCourierUpdateDTO);




    /**
     * 删除单个政策速递，彻底删除
     * @param policyCourierId 政策速递id
     * @return 删除数量
     */
    @ApiOperation(value="删除单个政策速递，彻底删除")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "policyCourierId", dataType = "String", value = "政策速递id", paramType = "path")
    })
    Result<Integer> delete(String policyCourierId);


    /**
     * 批量删除政策速递，彻底删除
     * @param policyCourierIds 政策速递id集合
     * @return 删除数量
     */
    @ApiOperation(value = "批量删除政策速递，彻底删除")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "policyCourierIds", dataType = "String[]", value = "政策速递id数组", paramType = "body" ,allowMultiple = true)
    })
    Result<Integer> deleteBatch(String[] policyCourierIds);


    /**
     * 根据政策速递id查询政策速递详情
     * @param policyCourierId 政策速递id
     * @return 政策速递详情
     */
    @ApiOperation(value="根据政策速递id查询政策速递详情")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "policyCourierId", dataType = "String", value = "政策速递id", paramType = "path")
    })
    Result<PolicyCourierVO> findById(String policyCourierId);


    /**
     * 查询政策速递
     * @param policyCourierQuery 政策速递查询参数
     * @return page
     */
    @ApiOperation(value="查询政策速递")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "policyCourierQuery", dataType = "PolicyCourierQuery", value = "政策速递查询参数", paramType = "query")
    })
    Result<List<PolicyCourierListVO>> listAll(PolicyCourierQuery policyCourierQuery);


     /**
     * 分页查询政策速递
     * @param policyCourierQuery 政策速递查询参数
     * @return page
     */
    @ApiOperation(value="分页查询政策速递")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "policyCourierQuery", dataType = "PolicyCourierQuery", value = "政策速递查询参数", paramType = "body")
    })
    Result<Page<PolicyCourierListVO>> selectPage(PolicyCourierQuery policyCourierQuery);


}

